<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: net_flow/net_env_simulator.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_460afd45d0ec637b1427e0e06a6fbcf7.html">net_flow</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">net_env_simulator.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="net__env__simulator_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow__fwd_8hpp.html">flow/net_flow/net_flow_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="log_8hpp.html">flow/log/log.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="random_8hpp.html">flow/util/random.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;boost/utility.hpp&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;boost/random.hpp&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &lt;queue&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">/**</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * Objects of this class can be fed to Node to make it internally simulate network conditions like</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * loss, latency, and data duplication.  At construction one provides parameters controlling those</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * phenomena; then when Node is about to receive or send some actual network traffic it asks this</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * object whether it should first simulate some phenomenon like a lost packet.  For example, if a</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * loss probability is given at construction, bool should_drop_received_packet() will return whether</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * the current received packet should be &quot;dropped&quot; instead of handled, which Node will simulate</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * internally by ignoring or handling the packet.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> *</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * This is not really meant as a replacement for real tools that simulate such phenomena (or</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * obviously the actual phenomena in a real network).  The way it simulates them is probably</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * unrealistic; for example a wide latency range given in the constructor will cause packets to be</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * re-ordered quite a bit, whereas on a real network the packets are more likely to arrive in the</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * right order but with widely varying latencies over time.  Anyway -- the idea of using this is not</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * to benchmark Node&#39;s performance under various network conditions; it is to test its correctness.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * For example: do frequent packet duplications and drops cause Node to enter an unexpected state</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * and crash?  What happens when an ESTABLISHED socket receives a late re-ordered SYN_ACK after</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * already getting some DATA?  Etc. etc.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * @todo One thing we should probably add for a bit of realism is the following.  If a loss range</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * [A, B] is specified, an individual packet&#39;s simulated latency will be a uniformly random number</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * in that range.  Because of this there will be frequent re-ordering of packets: if range</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * is [50, 100] ms, and we physically get packet X at time 0 and packet Y at time 5 ms, and the</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * simulated latencies are 80, 60 ms, respectively, then Y will &quot;arrive&quot; 80 - 60 - 5 = 15 ms BEFORE</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * X despite being sent earlier (assuming perfect actual network conditions under the simulation).</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * In reality, packets aren&#39;t re-ordered all that often.  So if we wanted to simulate a high latency</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * without re-ordering, we&#39;d have to set the range to [A, A] for some A.  To avoid having to do</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * that, we can add some internal memory into Net_env_simulator that would put a floor on a randomly</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * generated latency. In the previous example, the range for packet Y would be chosen as [75, 100]</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * (instead of [50, 100]) to guarantee that packet Y arrives at least a bit later than packet X.  Of</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * course that might skew the latency range in bursty traffic, but that might be an OK behavior.  We</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * could add a knob for how often to ignore this new logic and allow a re-ordering, so that that is</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * also simulated.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> */</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html">   67</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Net__env__simulator.html">Net_env_simulator</a> :</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1log_1_1Log__context.html">log::Log_context</a>,</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>{</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"></span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">  /// Short-hand for the random seed integer type.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#abfee43798dfbb7edb5428d1b939e5d53">   75</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#abfee43798dfbb7edb5428d1b939e5d53">seed_type_t</a> = uint32_t;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"></span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">  /// Short-hand for floating point between 0 and 1 used to express probability.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a6b0ed8c75b296b26b63eacb73e4b3d5d">   78</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a6b0ed8c75b296b26b63eacb73e4b3d5d">prob_type_t</a> = double;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"></span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">  /// Short-hand for list of packet loss outcomes.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#af810d3db1d281e1a29e9b0ebf578a2ca">   81</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#af810d3db1d281e1a29e9b0ebf578a2ca">Packet_loss_seq</a> = std::queue&lt;bool&gt;;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"></span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">  /// Short-hand for list of packet duplication outcomes.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a3ed1661440b977426b6d5be959ecc85a">   84</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a3ed1661440b977426b6d5be959ecc85a">Packet_dup_seq</a> = std::queue&lt;bool&gt;;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"></span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">  /// Short-hand for list of packet latencies.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a1db158ebdacaeea526a9d50c5beddc0d">   87</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a1db158ebdacaeea526a9d50c5beddc0d">Latency_seq</a> = std::queue&lt;Fine_duration&gt;;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"></span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">  /// Short-hand for latency range [low, high].</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a9dc71851284e2d20ab6760b82defa6b8">   90</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a9dc71851284e2d20ab6760b82defa6b8">Latency_range</a> = std::pair&lt;Fine_duration, Fine_duration&gt;;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"></span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   * Constructs simulator.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   *</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   * @param random_seed</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   *        Random seed to use for the internal random number generator.  Assuming all else is equal</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   *        (which can often be the case if all tested components are kept on the same</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   *        machine/loopback), using the same seed twice to run the same operations should result in</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   *        the same results.  If 0 is provided, seed is chosen based on the current time.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   * @param recv_packet_loss_prob</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   *        Probability that the given received packet will get dropped instead of actually being</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   *        received (0 is never; 1 is always; and anywhere in between).  This probability is</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   *        applied only once elements of recv_packet_loss_seq run out.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">   * @param recv_packet_loss_seq</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">   *        List of packet loss outcomes for received packets.  When packet `i` (in chronological</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">   *        order) is received, it is dropped instead of actually being received if the `i`-th element</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">   *        in `recv_packet_loss_seq` is true; otherwise it is not so dropped.  Once `i &gt;=</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">   *        recv_packet_loss_seq.size()`, `recv_packet_loss_prob` is used instead.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   * @param recv_latency_range</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   *        The range to use for the randomly generated latencies for received packets.  The pair</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   *        specifies the [min, max] (inclusive) latency range in its first and second elements</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   *        respectively.  The latency is chosen uniformly along that range.  This range is applied</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">   *        only once elements of `recv_latency_seq` run out.</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">   * @param recv_latency_seq</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">   *        List of latency outcomes for received packets.  When packet `i` (in chronological order)</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">   *        is received, it is lagged by N, where N is the `i`-th element in `recv_latency_seq`.  Once `i</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   *        &gt;= recv_latency_seq.size()`, `recv_latency_range is used instead.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   * @param recv_packet_dup_prob</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   *        Probability that the given received packet will get duplicated in addition to actually</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   *        being received (0 is never; 1 is always; and anywhere in between).  This probability is</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   *        applied only once elements of `recv_packet_dup_seq` run out.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   * @param recv_packet_dup_seq</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   *        List of packet loss outcomes for received packets.  When packet `i` (in chronological</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   *        order) is received, it is duplicated in addition to actually being received if</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   *        the `i`-th element in `recv_packet_dup_seq` is true; otherwise it is not so duplicated. Once</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   *        `i &gt;= recv_packet_dup_seq.size()`, `recv_packet_dup_prob` is used instead.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">   */</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a29cbd6ad9be0d9bf7ac72a4e0675d4b8">Net_env_simulator</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger_ptr,</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>                             <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#abfee43798dfbb7edb5428d1b939e5d53">seed_type_t</a> random_seed = 0,</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>                             <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a6b0ed8c75b296b26b63eacb73e4b3d5d">prob_type_t</a> recv_packet_loss_prob = 0,</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>                             <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#af810d3db1d281e1a29e9b0ebf578a2ca">Packet_loss_seq</a>&amp; recv_packet_loss_seq = <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#af810d3db1d281e1a29e9b0ebf578a2ca">Packet_loss_seq</a>(),</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>                             <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a9dc71851284e2d20ab6760b82defa6b8">Latency_range</a>&amp; recv_latency_range = <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a9dc71851284e2d20ab6760b82defa6b8">Latency_range</a>(),</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>                             <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a1db158ebdacaeea526a9d50c5beddc0d">Latency_seq</a>&amp; recv_latency_seq = <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a1db158ebdacaeea526a9d50c5beddc0d">Latency_seq</a>(),</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>                             <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a6b0ed8c75b296b26b63eacb73e4b3d5d">prob_type_t</a> recv_packet_dup_prob = 0,</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>                             <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a3ed1661440b977426b6d5be959ecc85a">Packet_dup_seq</a>&amp; recv_packet_dup_seq = <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a3ed1661440b977426b6d5be959ecc85a">Packet_dup_seq</a>());</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"></span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   * Low-level packet was received, but should we simulate that it was dropped before receipt?</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   * Probability and/or prescribed packet loss are set at construction.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">   *</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">   * @return `true` if dropped; `false` otherwise.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment">   */</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ad4f21b9f4db47570989e87af50b560ae">should_drop_received_packet</a>();</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"></span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   * Low-level packet was received and not dropped, but should we simulate that it was lagged by an</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">   * additional amount of time, before actually getting received, and if so how much?  Latency range</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">   * and/or prescribed latencies are set at construction.</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">   *</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">   * @return How long the next packet should be lagged.  May be zero.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">   */</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>  <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Net__env__simulator.html#aadc0bd07b7d8f589ec6f361ed4ed8c6c">received_packet_latency</a>();</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"></span> </div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">   * Low-level packet was received, but should we simulate that it was duplicated?</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment">   * Probability and/or prescribed packet duplication decisions are set at construction.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">   *</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">   * @return `true` if duplicated; `false` otherwise.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">   */</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ad3507a56fd416c215423d4519e4ac176">should_duplicate_received_packet</a>();</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span> </div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"></span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment">  /// Random number generator.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#aae1f08e4dec6c3e4855a3548b1e88ffb">  172</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#aae1f08e4dec6c3e4855a3548b1e88ffb">Random_generator</a> = <a class="code hl_typedef" href="classflow_1_1util_1_1Rnd__gen__uniform__range__base.html#a519fc83fd1c52a82618cd85f3a089668">util::Rnd_gen_uniform_range_base::Random_generator</a>;</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span> </div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"></span> </div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment">  /// Random seed for #m_rnd_generator (saved for reproducibility of &quot;random&quot; events).</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ac532250636f3ae5b045310e9d791c7d2">  177</a></span><span class="comment"></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#abfee43798dfbb7edb5428d1b939e5d53">seed_type_t</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ac532250636f3ae5b045310e9d791c7d2">m_seed</a>;</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"></span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment">  /// Random number generator for various random events like packet loss.</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a564e92e0cb49425be5962db80ef75a43">  180</a></span><span class="comment"></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#aae1f08e4dec6c3e4855a3548b1e88ffb">Random_generator</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a564e92e0cb49425be5962db80ef75a43">m_rnd_generator</a>;</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"></span> </div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment">   * At a given point in time, the `i`-th from now (in chronological order) received packet will be</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment">   * dropped if and only if the `i`-th element of #m_recv_packet_loss_seq is true.  For example, the</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">   * next packet will be dropped if and only if `m_recv_packet_loss_seq.front()` is `true`.</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment">   */</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a861af16185e100777bff382b278ac138">  187</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#af810d3db1d281e1a29e9b0ebf578a2ca">Packet_loss_seq</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a861af16185e100777bff382b278ac138">m_recv_packet_loss_seq</a>;</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"></span> </div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">  /// Returns `true` or `false` according to some probability set at construction; used for received packet loss.</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a599755f43627661e5ab721f57708ecac">  190</a></span><span class="comment"></span>  boost::random::bernoulli_distribution&lt;prob_type_t&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a599755f43627661e5ab721f57708ecac">m_recv_packet_loss_distribution</a>;</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"></span> </div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   * At a given point in time, the `i`-th from now (in chronological order) received packet will be</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment">   * lagged by value in `i`-th element of #m_recv_latency_seq.  For example, the next packet will lagged by</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment">   * `m_recv_latency_seq.front()`.</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment">   */</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ac14a4e2f96cde90306384313730ee914">  197</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a1db158ebdacaeea526a9d50c5beddc0d">Latency_seq</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ac14a4e2f96cde90306384313730ee914">m_recv_latency_seq</a>;</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"></span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment">   * Returns random latencies (in units of `Fine_duration`) within the improper [low, high] range</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment">   * given at construction; used for received packet latency.</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment">   */</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#aa077d5b9bc824da5fa7f3b504c83d33c">  203</a></span>  boost::random::uniform_int_distribution&lt;Fine_duration::rep&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#aa077d5b9bc824da5fa7f3b504c83d33c">m_recv_latency_distribution_msec</a>;</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"></span> </div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   * At a given point in time, the `i`-th from now (in chronological order) received packet will be</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * duplicated if and only if the `i`-th element of #m_recv_packet_dup_seq is `true`.  For example, the</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   * next packet will be duplicated if and only if `m_recv_packet_dup_seq.front()` is `true`.</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   */</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a2b05bfbdaee55c7ece72344e4a0f3b04">  210</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a3ed1661440b977426b6d5be959ecc85a">Packet_dup_seq</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#a2b05bfbdaee55c7ece72344e4a0f3b04">m_recv_packet_dup_seq</a>;</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"></span> </div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">  /// Returns `true` or `false` according to some probability set at construction; used for received packet duplication.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ab01aa06b2136ab24ef7d411698096fc4">  213</a></span><span class="comment"></span>  boost::random::bernoulli_distribution&lt;prob_type_t&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Net__env__simulator.html#ab01aa06b2136ab24ef7d411698096fc4">m_recv_packet_dup_distribution</a>;</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span>}; <span class="comment">// class Net_env_simulator</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span> </div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>} <span class="comment">// namespace flow::net_flow</span></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html">flow::log::Log_context</a></div><div class="ttdoc">Convenience class that simply stores a Logger and/or Component passed into a constructor; and returns...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01609">log.hpp:1610</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html">flow::net_flow::Net_env_simulator</a></div><div class="ttdoc">Objects of this class can be fed to Node to make it internally simulate network conditions like loss,...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00067">net_env_simulator.hpp:70</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a1db158ebdacaeea526a9d50c5beddc0d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a1db158ebdacaeea526a9d50c5beddc0d">flow::net_flow::Net_env_simulator::Latency_seq</a></div><div class="ttdeci">std::queue&lt; Fine_duration &gt; Latency_seq</div><div class="ttdoc">Short-hand for list of packet latencies.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00087">net_env_simulator.hpp:87</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a29cbd6ad9be0d9bf7ac72a4e0675d4b8"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a29cbd6ad9be0d9bf7ac72a4e0675d4b8">flow::net_flow::Net_env_simulator::Net_env_simulator</a></div><div class="ttdeci">Net_env_simulator(log::Logger *logger_ptr, seed_type_t random_seed=0, prob_type_t recv_packet_loss_prob=0, const Packet_loss_seq &amp;recv_packet_loss_seq=Packet_loss_seq(), const Latency_range &amp;recv_latency_range=Latency_range(), const Latency_seq &amp;recv_latency_seq=Latency_seq(), prob_type_t recv_packet_dup_prob=0, const Packet_dup_seq &amp;recv_packet_dup_seq=Packet_dup_seq())</div><div class="ttdoc">Constructs simulator.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8cpp_source.html#l00025">net_env_simulator.cpp:25</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a2b05bfbdaee55c7ece72344e4a0f3b04"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a2b05bfbdaee55c7ece72344e4a0f3b04">flow::net_flow::Net_env_simulator::m_recv_packet_dup_seq</a></div><div class="ttdeci">Packet_dup_seq m_recv_packet_dup_seq</div><div class="ttdoc">At a given point in time, the i-th from now (in chronological order) received packet will be duplicat...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00210">net_env_simulator.hpp:210</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a3ed1661440b977426b6d5be959ecc85a"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a3ed1661440b977426b6d5be959ecc85a">flow::net_flow::Net_env_simulator::Packet_dup_seq</a></div><div class="ttdeci">std::queue&lt; bool &gt; Packet_dup_seq</div><div class="ttdoc">Short-hand for list of packet duplication outcomes.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00084">net_env_simulator.hpp:84</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a564e92e0cb49425be5962db80ef75a43"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a564e92e0cb49425be5962db80ef75a43">flow::net_flow::Net_env_simulator::m_rnd_generator</a></div><div class="ttdeci">Random_generator m_rnd_generator</div><div class="ttdoc">Random number generator for various random events like packet loss.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00180">net_env_simulator.hpp:180</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a599755f43627661e5ab721f57708ecac"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a599755f43627661e5ab721f57708ecac">flow::net_flow::Net_env_simulator::m_recv_packet_loss_distribution</a></div><div class="ttdeci">boost::random::bernoulli_distribution&lt; prob_type_t &gt; m_recv_packet_loss_distribution</div><div class="ttdoc">Returns true or false according to some probability set at construction; used for received packet los...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00190">net_env_simulator.hpp:190</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a6b0ed8c75b296b26b63eacb73e4b3d5d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a6b0ed8c75b296b26b63eacb73e4b3d5d">flow::net_flow::Net_env_simulator::prob_type_t</a></div><div class="ttdeci">double prob_type_t</div><div class="ttdoc">Short-hand for floating point between 0 and 1 used to express probability.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00078">net_env_simulator.hpp:78</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a861af16185e100777bff382b278ac138"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a861af16185e100777bff382b278ac138">flow::net_flow::Net_env_simulator::m_recv_packet_loss_seq</a></div><div class="ttdeci">Packet_loss_seq m_recv_packet_loss_seq</div><div class="ttdoc">At a given point in time, the i-th from now (in chronological order) received packet will be dropped ...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00187">net_env_simulator.hpp:187</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_a9dc71851284e2d20ab6760b82defa6b8"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#a9dc71851284e2d20ab6760b82defa6b8">flow::net_flow::Net_env_simulator::Latency_range</a></div><div class="ttdeci">std::pair&lt; Fine_duration, Fine_duration &gt; Latency_range</div><div class="ttdoc">Short-hand for latency range [low, high].</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00090">net_env_simulator.hpp:90</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_aa077d5b9bc824da5fa7f3b504c83d33c"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#aa077d5b9bc824da5fa7f3b504c83d33c">flow::net_flow::Net_env_simulator::m_recv_latency_distribution_msec</a></div><div class="ttdeci">boost::random::uniform_int_distribution&lt; Fine_duration::rep &gt; m_recv_latency_distribution_msec</div><div class="ttdoc">Returns random latencies (in units of Fine_duration) within the improper [low, high] range given at c...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00203">net_env_simulator.hpp:203</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_aadc0bd07b7d8f589ec6f361ed4ed8c6c"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#aadc0bd07b7d8f589ec6f361ed4ed8c6c">flow::net_flow::Net_env_simulator::received_packet_latency</a></div><div class="ttdeci">Fine_duration received_packet_latency()</div><div class="ttdoc">Low-level packet was received and not dropped, but should we simulate that it was lagged by an additi...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8cpp_source.html#l00083">net_env_simulator.cpp:83</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_aae1f08e4dec6c3e4855a3548b1e88ffb"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#aae1f08e4dec6c3e4855a3548b1e88ffb">flow::net_flow::Net_env_simulator::Random_generator</a></div><div class="ttdeci">util::Rnd_gen_uniform_range_base::Random_generator Random_generator</div><div class="ttdoc">Random number generator.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00172">net_env_simulator.hpp:172</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_ab01aa06b2136ab24ef7d411698096fc4"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#ab01aa06b2136ab24ef7d411698096fc4">flow::net_flow::Net_env_simulator::m_recv_packet_dup_distribution</a></div><div class="ttdeci">boost::random::bernoulli_distribution&lt; prob_type_t &gt; m_recv_packet_dup_distribution</div><div class="ttdoc">Returns true or false according to some probability set at construction; used for received packet dup...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00213">net_env_simulator.hpp:213</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_abfee43798dfbb7edb5428d1b939e5d53"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#abfee43798dfbb7edb5428d1b939e5d53">flow::net_flow::Net_env_simulator::seed_type_t</a></div><div class="ttdeci">uint32_t seed_type_t</div><div class="ttdoc">Short-hand for the random seed integer type.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00075">net_env_simulator.hpp:75</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_ac14a4e2f96cde90306384313730ee914"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#ac14a4e2f96cde90306384313730ee914">flow::net_flow::Net_env_simulator::m_recv_latency_seq</a></div><div class="ttdeci">Latency_seq m_recv_latency_seq</div><div class="ttdoc">At a given point in time, the i-th from now (in chronological order) received packet will be lagged b...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00197">net_env_simulator.hpp:197</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_ac532250636f3ae5b045310e9d791c7d2"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#ac532250636f3ae5b045310e9d791c7d2">flow::net_flow::Net_env_simulator::m_seed</a></div><div class="ttdeci">seed_type_t m_seed</div><div class="ttdoc">Random seed for m_rnd_generator (saved for reproducibility of &quot;random&quot; events).</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00177">net_env_simulator.hpp:177</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_ad3507a56fd416c215423d4519e4ac176"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#ad3507a56fd416c215423d4519e4ac176">flow::net_flow::Net_env_simulator::should_duplicate_received_packet</a></div><div class="ttdeci">bool should_duplicate_received_packet()</div><div class="ttdoc">Low-level packet was received, but should we simulate that it was duplicated? Probability and/or pres...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8cpp_source.html#l00070">net_env_simulator.cpp:70</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_ad4f21b9f4db47570989e87af50b560ae"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#ad4f21b9f4db47570989e87af50b560ae">flow::net_flow::Net_env_simulator::should_drop_received_packet</a></div><div class="ttdeci">bool should_drop_received_packet()</div><div class="ttdoc">Low-level packet was received, but should we simulate that it was dropped before receipt?...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8cpp_source.html#l00057">net_env_simulator.cpp:57</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html_af810d3db1d281e1a29e9b0ebf578a2ca"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html#af810d3db1d281e1a29e9b0ebf578a2ca">flow::net_flow::Net_env_simulator::Packet_loss_seq</a></div><div class="ttdeci">std::queue&lt; bool &gt; Packet_loss_seq</div><div class="ttdoc">Short-hand for list of packet loss outcomes.</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00081">net_env_simulator.hpp:81</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Rnd__gen__uniform__range__base_html_a519fc83fd1c52a82618cd85f3a089668"><div class="ttname"><a href="classflow_1_1util_1_1Rnd__gen__uniform__range__base.html#a519fc83fd1c52a82618cd85f3a089668">flow::util::Rnd_gen_uniform_range_base::Random_generator</a></div><div class="ttdeci">boost::random::mt19937 Random_generator</div><div class="ttdoc">The random generator engine; it is public for the reason explained in Usability section of the Rnd_ge...</div><div class="ttdef"><b>Definition:</b> <a href="random_8hpp_source.html#l00041">random.hpp:41</a></div></div>
<div class="ttc" id="alog_8hpp_html"><div class="ttname"><a href="log_8hpp.html">log.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html"><div class="ttname"><a href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div><div class="ttdoc">Flow module containing the API and implementation of the Flow network protocol, a TCP-inspired stream...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_html_a48799f1263cdeedec125be51a3db2b79"><div class="ttname"><a href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">flow::Fine_duration</a></div><div class="ttdeci">Fine_clock::duration Fine_duration</div><div class="ttdoc">A high-res time duration as computed from two Fine_time_pts.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00416">common.hpp:416</a></div></div>
<div class="ttc" id="anet__flow__fwd_8hpp_html"><div class="ttname"><a href="net__flow__fwd_8hpp.html">net_flow_fwd.hpp</a></div></div>
<div class="ttc" id="arandom_8hpp_html"><div class="ttname"><a href="random_8hpp.html">random.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
